<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  <title>dil.semantic.Symbol</title>
  <link href="./css/style.css" rel="stylesheet" type="text/css"/>
  <!-- <link href="./img/icon.png" rel="icon" type="image/png"/> -->
  <script type="text/javascript" src="./js/jquery.js"></script>
  <script type="text/javascript" src="./js/modules.js"></script>
  <script type="text/javascript" src="./js/quicksearch.js"></script>
  <script type="text/javascript" src="./js/navigation.js"></script>
  <!--<script type="text/javascript" src="./js/jquery.treeview.js"></script>-->
  <script type="text/javascript">
    var g_moduleFQN = "dil.semantic.Symbol";
  </script>
  
</head>
<body>
<div id="content">
  <h1><a href="./htmlsrc/dil.semantic.Symbol.html" class="symbol">dil.semantic.Symbol</a></h1>
  
<p class="sec_header">Author:</p>Aziz Köksal
<p class="sec_header">License:</p>GPL3
 <p><b>Maturity:</b> average.</p>
<dl>
<dt class="decl">enum <a class="symbol _enum" name="SYM" href="./htmlsrc/dil.semantic.Symbol.html#L12" kind="enum" beg="12" end="29">SYM</a>; <a title="Permalink to this symbol" href="#SYM" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L12">#</a></dt>
<dd class="ddef">
<div class="summary">Enumeration of Symbol IDs.</div>
<dl>
<dt class="decl"><a class="symbol _enummem" name="SYM.Module" href="./htmlsrc/dil.semantic.Symbol.html#L14" kind="enummem" beg="14" end="14">Module</a> <a title="Permalink to this symbol" href="#SYM.Module" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L14">#</a></dt>
<dd class="ddef"></dd>
<dt class="decl"><a class="symbol _enummem" name="SYM.Package" href="./htmlsrc/dil.semantic.Symbol.html#L15" kind="enummem" beg="15" end="15">Package</a> <a title="Permalink to this symbol" href="#SYM.Package" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L15">#</a></dt>
<dd class="ddef"></dd>
<dt class="decl"><a class="symbol _enummem" name="SYM.Class" href="./htmlsrc/dil.semantic.Symbol.html#L16" kind="enummem" beg="16" end="16">Class</a> <a title="Permalink to this symbol" href="#SYM.Class" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L16">#</a></dt>
<dd class="ddef"></dd>
<dt class="decl"><a class="symbol _enummem" name="SYM.Interface" href="./htmlsrc/dil.semantic.Symbol.html#L17" kind="enummem" beg="17" end="17">Interface</a> <a title="Permalink to this symbol" href="#SYM.Interface" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L17">#</a></dt>
<dd class="ddef"></dd>
<dt class="decl"><a class="symbol _enummem" name="SYM.Struct" href="./htmlsrc/dil.semantic.Symbol.html#L18" kind="enummem" beg="18" end="18">Struct</a> <a title="Permalink to this symbol" href="#SYM.Struct" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L18">#</a></dt>
<dd class="ddef"></dd>
<dt class="decl"><a class="symbol _enummem" name="SYM.Union" href="./htmlsrc/dil.semantic.Symbol.html#L19" kind="enummem" beg="19" end="19">Union</a> <a title="Permalink to this symbol" href="#SYM.Union" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L19">#</a></dt>
<dd class="ddef"></dd>
<dt class="decl"><a class="symbol _enummem" name="SYM.Enum" href="./htmlsrc/dil.semantic.Symbol.html#L20" kind="enummem" beg="20" end="20">Enum</a> <a title="Permalink to this symbol" href="#SYM.Enum" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L20">#</a></dt>
<dd class="ddef"></dd>
<dt class="decl"><a class="symbol _enummem" name="SYM.EnumMember" href="./htmlsrc/dil.semantic.Symbol.html#L21" kind="enummem" beg="21" end="21">EnumMember</a> <a title="Permalink to this symbol" href="#SYM.EnumMember" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L21">#</a></dt>
<dd class="ddef"></dd>
<dt class="decl"><a class="symbol _enummem" name="SYM.Template" href="./htmlsrc/dil.semantic.Symbol.html#L22" kind="enummem" beg="22" end="22">Template</a> <a title="Permalink to this symbol" href="#SYM.Template" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L22">#</a></dt>
<dd class="ddef"></dd>
<dt class="decl"><a class="symbol _enummem" name="SYM.Variable" href="./htmlsrc/dil.semantic.Symbol.html#L23" kind="enummem" beg="23" end="23">Variable</a> <a title="Permalink to this symbol" href="#SYM.Variable" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L23">#</a></dt>
<dd class="ddef"></dd>
<dt class="decl"><a class="symbol _enummem" name="SYM.Function" href="./htmlsrc/dil.semantic.Symbol.html#L24" kind="enummem" beg="24" end="24">Function</a> <a title="Permalink to this symbol" href="#SYM.Function" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L24">#</a></dt>
<dd class="ddef"></dd>
<dt class="decl"><a class="symbol _enummem" name="SYM.Alias" href="./htmlsrc/dil.semantic.Symbol.html#L25" kind="enummem" beg="25" end="25">Alias</a> <a title="Permalink to this symbol" href="#SYM.Alias" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L25">#</a></dt>
<dd class="ddef"></dd>
<dt class="decl"><a class="symbol _enummem" name="SYM.OverloadSet" href="./htmlsrc/dil.semantic.Symbol.html#L26" kind="enummem" beg="26" end="26">OverloadSet</a> <a title="Permalink to this symbol" href="#SYM.OverloadSet" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L26">#</a></dt>
<dd class="ddef"></dd>
<dt class="decl"><a class="symbol _enummem" name="SYM.Scope" href="./htmlsrc/dil.semantic.Symbol.html#L27" kind="enummem" beg="27" end="27">Scope</a> <a title="Permalink to this symbol" href="#SYM.Scope" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L27">#</a></dt>
<dd class="ddef"></dd></dl></dd>
<dt class="decl">class <a class="symbol _class" name="Symbol" href="./htmlsrc/dil.semantic.Symbol.html#L32" kind="class" beg="32" end="118">Symbol</a>; <a title="Permalink to this symbol" href="#Symbol" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L32">#</a></dt>
<dd class="ddef">
<div class="summary">A symbol represents an object with semantic code information.</div>
<dl>
<dt class="decl">enum <a class="symbol _enum" name="Symbol.Status" href="./htmlsrc/dil.semantic.Symbol.html#L34" kind="enum" beg="34" end="39">Status</a>; <a title="Permalink to this symbol" href="#Symbol.Status" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L34">#</a></dt>
<dd class="ddef">
<div class="summary">Enumeration of symbol statuses.</div>
<dl>
<dt class="decl"><a class="symbol _enummem" name="Symbol.Status.Declared" href="./htmlsrc/dil.semantic.Symbol.html#L36" kind="enummem" beg="36" end="36">Declared</a> <a title="Permalink to this symbol" href="#Symbol.Status.Declared" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L36">#</a></dt>
<dd class="ddef">
<div class="summary">The symbol has been declared.</div></dd>
<dt class="decl"><a class="symbol _enummem" name="Symbol.Status.Completing" href="./htmlsrc/dil.semantic.Symbol.html#L37" kind="enummem" beg="37" end="37">Completing</a> <a title="Permalink to this symbol" href="#Symbol.Status.Completing" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L37">#</a></dt>
<dd class="ddef">
<div class="summary">The symbol is being processed.</div></dd>
<dt class="decl"><a class="symbol _enummem" name="Symbol.Status.Complete" href="./htmlsrc/dil.semantic.Symbol.html#L38" kind="enummem" beg="38" end="38">Complete</a> <a title="Permalink to this symbol" href="#Symbol.Status.Complete" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L38">#</a></dt>
<dd class="ddef">
<div class="summary">The symbol is complete.</div></dd></dl></dd>
<dt class="decl">SYM <a class="symbol _variable" name="Symbol.sid" href="./htmlsrc/dil.semantic.Symbol.html#L41" kind="variable" beg="41" end="41">sid</a>; <a title="Permalink to this symbol" href="#Symbol.sid" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L41">#</a></dt>
<dd class="ddef">
<div class="summary">The ID of this symbol.</div></dd>
<dt class="decl">Status <a class="symbol _variable" name="Symbol.status" href="./htmlsrc/dil.semantic.Symbol.html#L42" kind="variable" beg="42" end="42">status</a>; <a title="Permalink to this symbol" href="#Symbol.status" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L42">#</a></dt>
<dd class="ddef">
<div class="summary">The semantic status of this symbol.</div></dd>
<dt class="decl">Symbol <a class="symbol _variable" name="Symbol.parent" href="./htmlsrc/dil.semantic.Symbol.html#L43" kind="variable" beg="43" end="43">parent</a>; <a title="Permalink to this symbol" href="#Symbol.parent" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L43">#</a></dt>
<dd class="ddef">
<div class="summary">The parent this symbol belongs to.</div></dd>
<dt class="decl">Identifier* <a class="symbol _variable" name="Symbol.name" href="./htmlsrc/dil.semantic.Symbol.html#L44" kind="variable" beg="44" end="44">name</a>; <a title="Permalink to this symbol" href="#Symbol.name" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L44">#</a></dt>
<dd class="ddef">
<div class="summary">The name of this symbol.</div></dd>
<dt class="decl">Node <a class="symbol _variable" name="Symbol.node" href="./htmlsrc/dil.semantic.Symbol.html#L47" kind="variable" beg="47" end="47">node</a>; <a title="Permalink to this symbol" href="#Symbol.node" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L47">#</a></dt>
<dd class="ddef">
<div class="summary">The syntax tree node that produced this symbol.
 Useful for source code location info and retrieval of doc comments.</div></dd>
<dt class="decl"><a class="symbol _ctor" name="Symbol.this" href="./htmlsrc/dil.semantic.Symbol.html#L54" kind="ctor" beg="54" end="59">this</a><span class="params">(SYM <em>sid</em>, Identifier* <em>name</em>, Node <em>node</em>)</span>; <a title="Permalink to this symbol" href="#Symbol.this" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L54">#</a></dt>
<dd class="ddef">
<div class="summary">Constructs a Symbol object.</div>
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>sid</em></td><td>the symbol's ID.</td></tr>
<tr><td><em>name</em></td><td>the symbol's name.</td></tr>
<tr><td><em>node</em></td><td>the symbol's node.</td></tr></table></dd>
<dt class="decl">void <a class="symbol _function" name="Symbol.setCompleting" href="./htmlsrc/dil.semantic.Symbol.html#L62" kind="function" beg="62" end="63">setCompleting</a><span class="params">()</span>; <a title="Permalink to this symbol" href="#Symbol.setCompleting" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L62">#</a></dt>
<dd class="ddef">
<div class="summary">Change the status to Status.Completing.</div></dd>
<dt class="decl">void <a class="symbol _function" name="Symbol.setComplete" href="./htmlsrc/dil.semantic.Symbol.html#L66" kind="function" beg="66" end="67">setComplete</a><span class="params">()</span>; <a title="Permalink to this symbol" href="#Symbol.setComplete" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L66">#</a></dt>
<dd class="ddef">
<div class="summary">Change the status to Status.Complete.</div></dd>
<dt class="decl">bool <a class="symbol _function" name="Symbol.isCompleting" href="./htmlsrc/dil.semantic.Symbol.html#L70" kind="function" beg="70" end="71">isCompleting</a><span class="params">()</span>; <a title="Permalink to this symbol" href="#Symbol.isCompleting" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L70">#</a></dt>
<dd class="ddef">
<div class="summary">Returns true if the symbol is being completed.</div></dd>
<dt class="decl">bool <a class="symbol _function" name="Symbol.isComplete" href="./htmlsrc/dil.semantic.Symbol.html#L74" kind="function" beg="74" end="75">isComplete</a><span class="params">()</span>; <a title="Permalink to this symbol" href="#Symbol.isComplete" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L74">#</a></dt>
<dd class="ddef">
<div class="summary">Returns true if the symbols is complete.</div></dd>
<dt class="decl">template <a class="symbol _template" name="Symbol.isX" href="./htmlsrc/dil.semantic.Symbol.html#L78" kind="template" beg="78" end="81">isX</a><span class="tparams">(char[] kind)</span>; <span class="attrs">[<span class="prot">private</span>]</span> <a title="Permalink to this symbol" href="#Symbol.isX" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L78">#</a></dt>
<dd class="ddef">
<div class="summary">A template macro for building isXYZ() methods.</div>
<dl>
<dt class="decl">char[] <a class="symbol _variable" name="Symbol.isX.isX" href="./htmlsrc/dil.semantic.Symbol.html#L80" kind="variable" beg="80" end="80">isX</a>; <span class="attrs">[<span class="stc">const</span>]</span> <a title="Permalink to this symbol" href="#Symbol.isX.isX" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L80">#</a></dt>
<dd class="ddef"></dd></dl></dd>
<dt class="decl">Class <a class="symbol _function" name="Symbol.to" href="./htmlsrc/dil.semantic.Symbol.html#L99" kind="function" beg="99" end="103">to</a><span class="tparams">(Class)</span><span class="params">()</span>; <a title="Permalink to this symbol" href="#Symbol.to" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L99">#</a></dt>
<dd class="ddef">
<div class="summary">Casts the symbol to Class.</div></dd>
<dt class="decl">char[] <a class="symbol _function" name="Symbol.getFQN" href="./htmlsrc/dil.semantic.Symbol.html#L107" kind="function" beg="107" end="117">getFQN</a><span class="params">()</span>; <a title="Permalink to this symbol" href="#Symbol.getFQN" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/dil.semantic.Symbol.html#L107">#</a></dt>
<dd class="ddef">
<p class="sec_header">Returns:</p>the fully qualified name of this symbol.
 E.g.: dil.semantic.Symbol.Symbol.getFQN</dd></dl></dd></dl>
</div>
<div id="footer">
  <p>Copyright © 2007-2008, Aziz Köksal. All rights reserved.</p>
  <p>Page generated by <a href="http://code.google.com/p/dil">dil</a> on Fri Dec 26 04:12:57 2008. Rendered by <a href="http://code.google.com/p/dil/wiki/Kandil">kandil</a>.</p>
</div>
</body>
</html>